home *** CD-ROM | disk | FTP | other *** search
/ Sounds Terrific 2 / Sounds Terrific II (1996)(Weird Science)(Disc 1 of 2)[Amiga-PC].iso / archives / amiga / tracker_4_31.lzh / tracker / Docs / tracker.doc < prev    next >
Text File  |  1995-05-19  |  8KB  |  200 lines

  1. History:
  2. -------
  3. soundtracker was originally written by Karsten Obarsky for the amiga, a
  4. loong time ago. There have been numerous variants built upon it, the
  5. latest being protracker.
  6.  
  7. Liam Corner had the original idea of a player for the sunstation, and
  8. proved that it was possible. 
  9. I wouldn't have thought of writing it myself, but armed with his original code, 
  10. I used my knowledge of the amiga tracker format to `add some improvements'. 
  11. Of course, I ended up rewriting the whole code. At that point, it ran on 
  12. silicon graphics indigos and suns.
  13.  
  14. After that point, lots of people (see the thanks file) found that tracker
  15. was reasonably easy to port to their machines though quite buggy still.
  16. Some time later, tracker looks as if it works on many more machines, though
  17. that may simply be a deceptive illusion.
  18.  
  19. If you want to modify tracker or make it run on another machine, or correct
  20. problems, please do so.
  21.  
  22.  
  23. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  24. HOWEVER, IF YOU INTEND TO PORT IT TO ANOTHER MACHINE, I WOULD VERY MUCH
  25. APPRECIATE THAT YOU CHECK UP WITH ME FIRST. 
  26. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  27.  
  28.  
  29. There just might already be a port in progress, or I might have a newer
  30. version. Even so, I'd like to be able to maintain one source instead of
  31. a bazillion of versions. My e-mail is Marc.Espie@ens.fr, not liable to change
  32. for some time.
  33.  
  34. PRELIMINARY
  35. -----------
  36. As I am a lazy person, this file tends to change more slowly than the tracker
  37. program itself.  Some options may no longer exist, some may have been added.
  38. Many things may be different.  I mainly try to get out a working, efficient
  39. reasonably bug-free program.  If I manage to write corresponding docs, fine !
  40. If I don't, tough luck ! Anyhow, looking at the source file should provide
  41. you with enough insight for everything.
  42. --
  43.  
  44. To build tracker, you should have a good look at the Makefile.
  45. Usually, just changing the install dir, and machine, then
  46. make install should be enough.  You may want to install tracker by hand,
  47. as it is trivial. I'm trying to maintain all versions in a functional
  48. state, but updates come more or less often depending on the individual 
  49. porters.
  50.  
  51. tracker is a giftware program, it is not guaranteed to do anything
  52. at all, either useful or useless. You've been warned, use it at your own risk. 
  53. This said, there doesn't seem to be any relevant bugs left in the current
  54. revision of code, and it is getting more and more stable.
  55.  
  56. ``Soundtracker'' is a family of music composition programs
  57. that exists on the amiga. The resulting data files (modules)
  58. have been appearing on ftp sites for some time now.
  59.  
  60. For a machine with sufficient horsepower and some audio capability,
  61. it is possible to emulate the amiga audio hardware in real time,
  62. and play those modules.
  63. After that, you're only limited by the machine's capabilities. The
  64. sparc is a bit poor (8Khz sampling), in contrast with the indigo,
  65. which gives an almost perfect rendition of most modules.
  66.  
  67. This release of tracker supports most amiga soundtracker file formats,
  68. and plays most of the existing effects, so that about 99% of the modules
  69. are output correctly.
  70.  
  71. Here is some supplementary information.
  72.  
  73. Compression:
  74. various compression methods are supported through pipes. There is a 
  75. simple-minded compression_methods file (check Makefile to see where you want
  76. to install it). Its format is:
  77. extension    command line in printf format.
  78.  
  79. For instance, 
  80. .gz    gzip -dc %s
  81. (simple, isn't it ?)
  82.  
  83. Environment variables:
  84. OVERSAMPLE can be used to control the accuracy of the reproduction.
  85. (The number of samples used to output one audio word).
  86. The higher, the better, but the more CPU it will use. The default
  87. value (1) is quite good at high frequencies, but not so for, for instance
  88. a poor sparc station's 8000 Hz. You can try, say, 2 or 3. After that,
  89. there won't be any noticeable improvement, and anyway, the program won't
  90. be fast enough to keep up with the output rate. Note that the program is
  91. special-cased for the default value (1), which should be significantly faster
  92. on some architectures.
  93.  
  94. FREQUENCY can be used to set the audio output at a specific frequency
  95. (if the hardware supports it). The hardware will decide which frequency
  96. to actually use, according to other external parameters.
  97.  
  98. MONO can be used to force mono output, which uses less
  99. cpu power.
  100.  
  101. TRANSPOSE is the number of halftones to transpose each note (>0 is higher).
  102. Useful for low frequency sparcs which can't play some tunes accurately, or
  103. when you get bored...
  104.  
  105. MODPATH can be set to be a path where you wish to look for mod files. This
  106. is a sh-styled path: setenv MODPATH dir1:dir2:...
  107.  
  108. TRACKER_COMPRESSION can be set to override the default compression_methods
  109. file... Very useful when, for example, you want to use a binary fetched from
  110. the net.
  111.  
  112. Command line switches:
  113. -stereo/-mono: 
  114.     switch between stereo/mono output
  115. -mix <percent>: 
  116.     for stereo output, decide how to mix left/right channels.
  117.     0 is spatial stereo, 100 is mono. The change tends to
  118.     be exponential, so you may want to experiment with values 
  119.     around 90+.
  120. -frequency <freq>:
  121.     ask for a given output frequency (in kHz). The normal output frequency
  122.     is a `normal' frequency for your machine. <freq> will be rounded
  123.     to a near available value.
  124. -oversample <n>:
  125.     where n is usually 1, 2 or 3. Try to use 1,2 or 3 sample values
  126.     to accurately render a given sample. Changing the frequency 
  127.     usually works better, but there might be cases where 2 or 3 gives
  128.     you a better rendering for a given module. Big cpu-eater.
  129.     0 is a special mode, called linear resampling. As a rule, if you have
  130.     a sufficient output frequency, resampling is not really necessary.
  131. -new/old/both:
  132.     select a soundtracker format, between new (31 instr), old (15 instr)
  133.     and both (auto-detect what's going on). You should only use it if
  134.     tracker gets very confused on a module.
  135. -picky:
  136.     do not allow for any problems in a module.
  137. -tolerant:
  138.     allow for many problems that would normally stop a module
  139. -repeats / -repeats <n>:
  140.     repeat each module n times. With no value (or a 0), repeat the
  141.     module forever.
  142. -looping
  143.     make the whole module list loop.
  144. -verbose:
  145.     show a sample listing for the module.
  146. -scroll:
  147.     scroll-display the module being played.
  148. -color/-bw:
  149.     use with terminals with color-ansi capability (e.g., kterm)
  150.     to get a colorful scroll.
  151. -sync:
  152.     try to synchronize that scroll display with what you hear.
  153.     Needs much cpu power to work correctly. Not implemented for many
  154.     architectures.
  155. -speed <n>:
  156.     change the base tempo to n. The normal value is 50 (PAL video
  157.     frequency). Some modules have been written on a buggy NTSC composer,
  158.     so you may wish to use -speed 60. Weird values like -speed 10 or
  159.     -speed 2000 are allowable. 
  160.     Note that the samples may sound a bit strange since you only change
  161.     the tempo there.
  162. -speedmode (normal|old|finefirst|normalfirst):
  163.     compatibily hack for old soundtracker tunes and various variants.
  164. -transpose <k>:
  165.     transpose the song up k half-notes. Doesn't work all the time.
  166.     Doesn't work right most of the time. For fun only. If k is
  167.     negative, it obviously transposes the song down.
  168. -start n:
  169.     start the module at pattern number n instead of number 0
  170.  
  171.         Sample control:
  172.         --------------
  173. -cut 012...abcd:
  174.     suppress samples from the audio output.
  175. -add 012..abcd 
  176.     add samples to the audio output (exclusive with cut).
  177.  
  178.  
  179. Runtime control:
  180.     n: go to next song
  181.     p: restart current song/go to previous song
  182.     >: fast forward
  183.     <: rewind
  184.     S: NTSC tempo (60)
  185.     s: PAL tempo (50)
  186.     q
  187.     x
  188.     e: quit right away
  189.     +: (sparc only) increase sampling rate
  190.     -: (sparc only) decrease sampling rate
  191.  
  192. Send bug reports to Marc.Espie@ens.fr,
  193.  
  194. encouragements and nice things to Marc.Espie@ens.fr, zenith@dcs.warwick.ac.uk, 
  195. and all the other guys in the thanks file.
  196. --
  197.  
  198.     Marc Espie, Paris, may 1995
  199.  
  200.